/*
 * Copyright 2016-2018 shardingsphere.io.
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * </p>
 */

package io.shardingsphere.shardingproxy.transport.mysql.packet.command.query.binary.execute.protocol;

import io.shardingsphere.shardingproxy.transport.mysql.packet.MySQLPacketPayload;

import java.sql.SQLException;

/**
 * Binary protocol value.
 *
 * @see <a href="https://dev.mysql.com/doc/internals/en/binary-protocol-value.html">Binary Protocol Value</a>
 *
 * @author zhangyonglun
 * @author zhangliang
 */
public interface BinaryProtocolValue {
    
    /**
     * Read binary protocol value.
     *
     * @param payload payload operation for MySQL packet
     * @return binary value result
     * @throws SQLException SQL exception
     */
    Object read(MySQLPacketPayload payload) throws SQLException;
    
    /**
     * Write binary protocol value.
     *
     * @param payload payload operation for MySQL packet
     * @param value value to be written
     */
    void write(MySQLPacketPayload payload, Object value);
}
